<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>buffer_registration</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="buffer_copy/overload2.html" title="buffer_copy (2 of 2 overloads)">
    <link rel="next" href="buffer_registration/allocator_type.html" title="buffer_registration::allocator_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="buffer_copy/overload2.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                   href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="buffer_registration/allocator_type.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.buffer_registration"></a><a class="link" href="buffer_registration.html"
                                                                    title="buffer_registration">buffer_registration</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.buffer_registration"></a>
    </p>
    <p>
        Automatically registers and unregistered buffers with an execution context.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html"
                                             title="Mutable buffer sequence requirements">MutableBufferSequence</a><span
                class="special">,</span>
    <span class="keyword">typename</span> <span class="identifier">Allocator</span> <span class="special">=</span> <span
                class="identifier">std</span><span class="special">::</span><span
                class="identifier">allocator</span><span class="special">&lt;</span><span
                class="keyword">void</span><span class="special">&gt;&gt;</span>
<span class="keyword">class</span> <span class="identifier">buffer_registration</span>
</pre>
    <h5>
        <a name="asio.reference.buffer_registration.h0"></a>
        <span><a name="asio.reference.buffer_registration.types"></a></span><a class="link"
                                                                               href="buffer_registration.html#asio.reference.buffer_registration.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/allocator_type.html"
                           title="buffer_registration::allocator_type"><span
                                class="bold"><strong>allocator_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The allocator type used for allocating storage for the buffers
                        container.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/const_iterator.html"
                           title="buffer_registration::const_iterator"><span
                                class="bold"><strong>const_iterator</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of a const iterator over the registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/iterator.html"
                           title="buffer_registration::iterator"><span class="bold"><strong>iterator</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of an iterator over the registered buffers.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.buffer_registration.h1"></a>
        <span><a name="asio.reference.buffer_registration.member_functions"></a></span><a class="link"
                                                                                          href="buffer_registration.html#asio.reference.buffer_registration.member_functions">Member
        Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/at.html" title="buffer_registration::at"><span
                                class="bold"><strong>at</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the buffer at the specified index.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/begin.html" title="buffer_registration::begin"><span
                                class="bold"><strong>begin</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the begin iterator for the sequence of registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/buffer_registration.html"
                           title="buffer_registration::buffer_registration"><span class="bold"><strong>buffer_registration</strong></span></a>
                        <span class="silver">[constructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Register buffers with an executor's execution context. <br> <span class="silver"> —</span>
                        <br> Register buffers with an execution context. <br> <span class="silver"> —</span><br>
                        Move constructor.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/cbegin.html" title="buffer_registration::cbegin"><span
                                class="bold"><strong>cbegin</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the begin iterator for the sequence of registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/cend.html" title="buffer_registration::cend"><span
                                class="bold"><strong>cend</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the end iterator for the sequence of registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/end.html" title="buffer_registration::end"><span
                                class="bold"><strong>end</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the end iterator for the sequence of registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/operator_eq_.html"
                           title="buffer_registration::operator="><span
                                class="bold"><strong>operator=</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Move assignment.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/operator_lb__rb_.html"
                           title="buffer_registration::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the buffer at the specified index.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/size.html" title="buffer_registration::size"><span
                                class="bold"><strong>size</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the number of registered buffers.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="buffer_registration/_buffer_registration.html"
                           title="buffer_registration::~buffer_registration"><span class="bold"><strong>~buffer_registration</strong></span></a>
                        <span class="silver">[destructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Unregisters the buffers.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <p>
        For portability, applications should assume that only one registration is
        permitted per execution context.
    </p>
    <h5>
        <a name="asio.reference.buffer_registration.h2"></a>
        <span><a name="asio.reference.buffer_registration.requirements"></a></span><a class="link"
                                                                                      href="buffer_registration.html#asio.reference.buffer_registration.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffer_registration.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="buffer_copy/overload2.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                   href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="buffer_registration/allocator_type.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
